Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jan 6, 2025

use ScrollIntoView function

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #5042

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Use the browser's built-in scrollIntoView API for scrolling active items into view within the select component.

Bug Fixes:

  • Fix scrolling issue within the select dropdown.

Enhancements:

  • Improve scrolling behavior in the select component.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 6, 2025

Reviewer's Guide by Sourcery

This PR fixes a bug in the Select component where the active item was not scrolled into view when the dropdown was opened. The fix replaces custom scroll logic with the standard scrollIntoView function.

Sequence diagram for Select component dropdown interaction

sequenceDiagram
    participant User
    participant Select
    participant Dropdown
    participant ScrollHandler

    User->>Select: Opens dropdown
    Select->>Dropdown: shown.bs.dropdown/shown.bs.popover
    Dropdown->>Select: Find active item
    Select->>ScrollHandler: scrollIntoView(active item)
    Note over ScrollHandler: Uses native scrollIntoView
    Note over ScrollHandler: with 'center' alignment
Loading

State diagram for Select component scroll behavior

stateDiagram-v2
    [*] --> Closed
    Closed --> Open: User clicks
    Open --> ScrollRequired: Active item exists
    Open --> Idle: No active item
    ScrollRequired --> Scrolling: Call scrollIntoView
    Scrolling --> Idle: Scroll complete
    Idle --> Closed: User closes
    Scrolling --> Closed: User closes
Loading

File-Level Changes

Change Details Files
Replaced custom scroll logic with the standard scrollIntoView function.
  • Removed the scrollToActive function.
  • Removed the getTop function.
  • Added the scrollIntoView function.
  • Updated the shown and keydown event handlers to use scrollIntoView.
  • Removed unnecessary calculations and logic related to scrolling.
  • Updated event handling for dropdown and popover display to use scrollIntoView.
src/BootstrapBlazor/Components/Select/Select.razor.js

Assessment against linked issues

Issue Objective Addressed Explanation
#5042 When IsPopover is true, the dropdown should scroll to the current selected item's position
#5042 Correctly calculate scrollbar position when there are many grouped items and the selected item is towards the end

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@bb-auto bb-auto bot added the bug Something isn't working label Jan 6, 2025
@bb-auto bb-auto bot added this to the v9.2.0 milestone Jan 6, 2025
@ArgoZhang ArgoZhang merged commit f5f401d into main Jan 6, 2025
3 checks passed
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ArgoZhang ArgoZhang deleted the fix-select branch January 6, 2025 05:58
@codecov
Copy link

codecov bot commented Jan 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (88fba62) to head (11fef73).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #5047   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          631       631           
  Lines        27964     27964           
  Branches      4008      4008           
=========================================
  Hits         27964     27964           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

bug(Select): 下拉选择框滚动条位置不正确

2 participants